home *** CD-ROM | disk | FTP | other *** search
/ The Games Machine 131 / XENIATGM131.iso / Goodies / I-WAR 2 Egde of Chaos - New SDK / IW2-EOC_Pog_Scripting_SDK.exe / include / iDirector.h < prev    next >
C/C++ Source or Header  |  2002-01-14  |  5KB  |  257 lines
  1. //
  2. // (c) 2000 Particle Systems Ltd. All Rights Reserved
  3. //
  4. // iDirector.h
  5. //
  6. // API for the package iDirector.
  7. //
  8. // Revision control information:
  9. //
  10. // $Header: /iwar2/packages/iDirector.h 9     5/03/01 11:39 Derekm $
  11. //
  12.  
  13. #include "Flux.h"
  14.  
  15. #ifdef FLUX_COMPILE
  16.  
  17. FLUX_DECLARE_EXTENSION(iDirector);
  18.  
  19. #ifdef FLUX_LIB
  20. #if _MSC_VER >= 1000
  21. #pragma comment( lib, "iDirector" )
  22. #endif // _MSC_VER >= 1000
  23. #endif // FLUX_LIB
  24. #else
  25.  
  26. uses Sim;
  27.  
  28. /**
  29.  * Camera types. These must be kept in sync with cameras\iDirector.h
  30.  */
  31. enum eCamera 
  32. { 
  33.     CAM_None,
  34.  
  35.     // Internal camera
  36.     CAM_Internal, 
  37.  
  38.     // Internal camera without cockpit
  39.     CAM_InternalNoCockpit,
  40.  
  41.     // Internal no HUD
  42.     CAM_InternalNoHUD,
  43.  
  44.     // Chase camera
  45.     CAM_Chase,
  46.  
  47.     // Chase camera with headup
  48.     CAM_Arcade,
  49.     
  50.     // External camera
  51.     CAM_External, 
  52.  
  53.     // Target external camera
  54.     CAM_TargetExternal, 
  55.  
  56.     // Tactical camera
  57.     CAM_Tactical,
  58.  
  59.     // Inverse tactical camera
  60.     CAM_InverseTactical,
  61.  
  62.     // Flyby camera
  63.     CAM_Flyby,
  64.  
  65.     // Drop camera
  66.     CAM_Drop, 
  67.  
  68.     // Distant drop camera
  69.     CAM_DistantDrop, 
  70.  
  71.     // Two-shot camera (focus on left, target on right)
  72.     CAM_TwoShot,
  73.  
  74.     // Two-shot camera (foci reversed)
  75.     CAM_InverseTwoShot,
  76.  
  77.     // Conversation camera (focus on left, target on right)
  78.     CAM_Conversation,
  79.  
  80.     // Bridge shot camera (look at the front of the primary)
  81.     CAM_BridgeShot,
  82.  
  83.     // Target bridge shot camera (look at the front of the secondary)
  84.     CAM_TargetBridgeShot,
  85.  
  86.     // Contact camera (used to render target MFD)
  87.     CAM_Contact,
  88.  
  89.     // Dolly camera, primary is the camera, secondary is looked at
  90.     CAM_Dolly,
  91.  
  92.     // Tactical camera with no HUD
  93.     CAM_TacticalNoHUD,
  94.  
  95.     // Distant bridge shot
  96.     CAM_DistantBridgeShot,
  97.  
  98.     // Number of cameras.
  99.     eCameraCount
  100. };
  101.  
  102. //
  103. // Begin function
  104. //
  105. // prototype void iDirector.Begin();
  106. //
  107. prototype iDirector.Begin();
  108.  
  109. //
  110. // End function
  111. //
  112. // prototype void iDirector.End();
  113. //
  114. prototype iDirector.End();
  115.  
  116. //
  117. // IsBusy
  118. //
  119. // prototype bool iDirector.IsBusy();
  120. //
  121. prototype bool iDirector.IsBusy();
  122.  
  123. //
  124. // Captioning
  125. //
  126.  
  127. //
  128. // SetCaption
  129. //
  130. // prototype void iDirector.InUse();
  131. //
  132. prototype iDirector.SetCaption(string caption, float time);
  133.  
  134. //
  135. // Focus
  136. //
  137.  
  138. //
  139. // Focus
  140. //
  141. // prototype void iDirector.Focus();
  142. //
  143. prototype hsim iDirector.Focus();
  144.  
  145. //
  146. // SetFocus
  147. //
  148. // prototype void iDirector.SetFocus();
  149. //
  150. prototype iDirector.SetFocus(hsim sim);
  151.  
  152. //
  153. // SecondaryFocus
  154. //
  155. // prototype void iDirector.SecondaryFocus();
  156. //
  157. prototype hsim iDirector.SecondaryFocus();
  158.  
  159. //
  160. // SetSecondaryFocus
  161. //
  162. // prototype void iDirector.SetSecondaryFocus();
  163. //
  164. prototype iDirector.SetSecondaryFocus(hsim sim);
  165.  
  166. //
  167. // Set camera
  168. //
  169.  
  170. //
  171. // Read the current camera
  172. //
  173. prototype eCamera iDirector.Camera();
  174.  
  175. //
  176. // Set the current camera
  177. //
  178. prototype iDirector.SetCamera(eCamera camera);
  179.  
  180. //
  181. // Dolly
  182. //
  183.  
  184. //
  185. // Create a dolly
  186. //
  187. prototype hsim iDirector.CreateDolly();
  188.  
  189. //
  190. // Given two sims, set the direction of motion
  191. //
  192. prototype hsim iDirector.SetDirection(hsim dolly, hsim a, hsim b, float time, float acc_time);
  193.  
  194. //
  195. // Use the given sim as a dolly camera. The dolly is used as the secondary
  196. // focus, looking at the primary focus
  197. //
  198. prototype hsim iDirector.SetDollyCamera(hsim dolly);
  199.  
  200. //
  201. // Attach the dolly cam to a sim. The dolly will be removed
  202. // from any other sim its on.
  203. //
  204. prototype hsim iDirector.AttachDollyToSim(hsim dolly, hsim sim);
  205.  
  206. //
  207. // Orientation of the dolly view is normally defined by what is being
  208. // looked at (the primary focus). Calling this with true will allow
  209. // the orientation to be picked up from the dolly sim orientation.
  210. // Calling with false will reset to the normal behaviour
  211. //
  212. prototype iDirector.UseDollyOrientation(hsim dolly, bool dolly_orientation);
  213.  
  214. //
  215. // Pick the view orientation from a given sim
  216. //
  217. prototype iDirector.UseSimOrientation(hsim dolly, hsim sim);
  218.  
  219. //
  220. // Set the dolly to look forward
  221. //
  222. prototype iDirector.DollyLookForward(hsim dolly);
  223.  
  224. //
  225. // Set Field of view 
  226. //
  227. prototype hsim iDirector.SetFieldOfView(float fov);
  228.  
  229. //
  230. // Set Field of view between the two angles over time seconds
  231. //
  232. prototype hsim iDirector.SetInterpolateFieldOfView(float from, float to, float time);
  233.  
  234. //
  235. // Set Field of view between the two angles over time seconds
  236. //
  237. prototype iDirector.Obituary(string caption);
  238.  
  239. //
  240. // Set Field of view between the two angles over time seconds
  241. //
  242. prototype bool iDirector.IsObituaryView();
  243.  
  244. //
  245. // Fade out to colour (r, g, b) over time seconds
  246. //
  247. prototype bool iDirector.FadeOut(float time, float r, float g, float b);
  248.  
  249. //
  250. // Fade in from colour (r, g, b) over time seconds
  251. //
  252. prototype bool iDirector.FadeIn(float time, float r, float g, float b);
  253.  
  254. // EOF ////////////////////////////////////////////////////////////////////////
  255.  
  256. #endif // FLUX_LIB
  257.